API Guide - NHN Cloud User Guide

Governance & Audit > Resource Watcher > API 가이드

Resource Watcher에 RESTful API를 호출해 이벤트 및 리소스들의 상태 변경에 따른 알림을 설정할 수 있습니다.

User Access Key & Secret Access Key

REST API를 사용하려면 먼저 User Access Key와 Secret Access Key를 발급 받아야 합니다.
User Access Key와 Secret Access Key는 API 보안 설정에서 발급할 수 있습니다.
콘솔 우측 상단의 계정에 마우스 포인터를 올리면 표시되는 드롭다운 메뉴에서 API 보안 설정을 선택한 뒤 User Access Key ID 생성을 클릭합니다.
보안을 위해 User Access Key와 Secret Access Key를 모두 생성하는 것을 권장합니다.

[그림 1] API 보안 설정 위치

[그림 2] API 보안 설정 페이지

[그림 3] UserAccessKey와 SecretAccessKey 생성

[그림 3] User Access Key와 Secret Access Key 생성

Public API URL & Appkey 확인

RESTful API를 사용하려면 Appkey가 필요합니다.
콘솔 우측의 URL & Appkey를 클릭해 발급된 key 정보를 확인할 수 있습니다. [그림 4] Public API URL & Appkey

[그림 4] URL & Appkey

REST API 가이드

Common Response Body

모든 API 요청에 대해 HTTP 응답 코드는 200으로 응답합니다.
자세한 응답 결과는 Response Body의 header 항목을 참고합니다.

Key	Type	Description
header	Header	응답 헤더

Header

Key	Type	Description
isSuccessful	boolean	성공 여부(true, false)
resultCode	int	응답 코드. 성공 시 0, 실패 시 오류 코드 반환
resultMessage	String	응답 메시지. 성공 시 "SUCCESS", 실패 시 오류 메시지 반환

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  }
}

1. Alarm

1.1 Alarm 등록하기

[기본 정보]

Method	URI
POST	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms

권한
O_OWNER, O_ADMIN, O_LOG_VIEWER

리소스에서 발생하는 이벤트에 대한 알림을 설정할 수 있습니다.

설정할 이벤트 정보는 3.1. Event 목록 조회 API의 응답 결과를 참고하십시오.
알람 대상에는 멤버, 알림 수신 그룹, 역할, WebHook 타입이 있으며, 각 타입별로 대상을 설정할 수 있습니다
리소스 대상에는 리소스 그룹/태그를 설정할 수 있습니다.
이벤트 전체로 설정하면 특정 리소스에서 발생하는 모든 이벤트에 대해 알림을 수신하도록 설정할 수 있습니다.
리소스 전체로 설정하면 리소스에 관계없이 특정 이벤트에 대한 알림을 수신하도록 설정할 수 있습니다.
이벤트 전체와 리소스 전체는 동시에 설정할 수 없습니다.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	콘솔에서 발급 받은 User Access Key
X-TC-AUTHENTICATION-SECRET	콘솔에서 발급 받은 Secret Access Key

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 상품 Appkey

[Request Body]

Key	Type	Required	Description
alarm	Alarm	Yes	알림 정보
alarmTargets	AlarmTarget[]	Yes	알림 수신 대상 정보
events	Event[]	No	알림 대상 이벤트 목록 발생하는 모든 이벤트에 대해 수신을 원할 경우 설정하지 않음.
target	Target	No	대상 리소스 정보 리소스 관계없이 이벤트를 수신할 경우 설정하지 않음.

Alarm

Key	Type	Required	Description
alarmName	String	Yes	알림 이름 최대 255 글자까지 등록 가능
description	String	No	알림 설명 최대 1,000 글자까지 등록 가능

AlarmTarget

Key	Type	Required	Description
alarmTargetTypeCode	String	Yes	알림 대상 타입 1. `UUID`: 단일 조직 멤버 대상(NHN cloud 회원, IAM 멤버) 2. `ROLE`: 역할 대상(조직 역할, 프로젝트 역할 그룹, 프로젝트 역할) 3. `ALARM_KEY`: 알림 수신 그룹 대상(조직 알림 수신 그룹, 프로젝트 알림 수신 그룹) 4. `WEBHOOK`: 웹훅
alarmTarget	String	No	알림 대상 정보 <타입별 설정 값> 1. UUID: `멤버 UUID` 2. ROLE: `역할 ID`(ex. ADMIN) 3. ALARM_KEY: `알림 수신 그룹 ID` 4. WEBHOOK: `입력하지 않음`
emailAlarm	String	No	이메일 수신 여부 1. `Y`: 이메일 수신 2. `N`: 이메일 수신하지 않음 WEBHOOK, ALARM_KEY는 입력하지 않음.
smsAlarm	String	No	SMS 수신 여부 1. `Y`: SMS 수신 2. `N`: SMS 수신하지 않음 WEBHOOK, ALARM_KEY는 입력하지 않음.
webhookUrl	String	No	Webhook URL 주소 http:// 또는 https://로 시작해야 함 알림 대상 타입 `WEBHOOK` 설정 시 입력
webhookSecret	String	No	Webhook 비밀 키 알림 대상 타입 `WEBHOOK` 설정 시 입력

Event

Key	Type	Required	Description
productId	String	Yes	서비스 ID
eventId	String	Yes	이벤트 ID

productId, eventId 값은 3.1 이벤트 목록 조회 API 응답값 을 참고하십시오.

Target

Key	Type	Required	Description
resourceGroupIds	String[]	No	리소스 그룹 ID 목록
resourceTagIds	Long[]	No	리소스 태그 ID 목록

예제)

{
  "alarm": {
    "alarmName": "",
    "description": ""
  },
  "alarmTargets": [
    {
      "alarmTarget": "",
      "alarmTargetTypeCode": "",
      "emailAlarm": "",
      "smsAlarm": "",
      "webhookSecret": "",
      "webhookUrl": ""
    }
  ],
  "events": [
    {
      "eventId": "",
      "productId": ""
    }
  ],
  "target": {
    "resourceGroupIds": [
      ""
    ],
    "resourceTagIds": [
      ""
    ]
  }
}

[Response Body]

Key	Type	Description
alarm	Alarm	알림 정보
alarmTargetAlarmKeys	AlarmTargetAlarmKey[]	알림의 수신 대상 목록
alarmTargetMemberProfiles	AlarmTargetMemberProfile[]	알림 수신 대상 프로필 목록
alarmTargetRoles	AlarmTargetRole[]	알림 수신 대상 ROLE 목록
alarmTargets	AlarmTarget[]	알림 수신 대상 목록
events	Event[]	알림 이벤트 목록
target	Target	대상 리소스 정보

Alarm

Key	Type	Description
alarmId	String	알림 ID
alarmName	String	알림 이름
alarmRule	AlarmRule	알림 규칙 상세 정보
alarmStatusCode	String	알림 상태 코드 <종류> 1. STABLE: 활성화 2. DISABLED: 비활성화 3. CLOSED: 삭제
appKey	String	Appkey 정보
cabAlarmKey	String	알림 수신 그룹 ID
delDatetime	Date	삭제 일시
description	String	알림 설명
modDatetime	Date	수정 일시
operatorUuid	String	최종 수정한 사용자 UUID
regDatetime	Date	등록 일시

AlarmRule

Key	Type	Description
alarmRuleId	String	알림 규칙 ID
alarmRuleStatusCode	String	알림 규칙 상태 코드 <종류> 1. STABLE: 활성화 2. DISABLED: 비활성화 3. CLOSED: 삭제
alarmRuleName	String	알림 규칙 이름
alarmRuleDescription	String	알림 규칙 설명
resourceTypes	String[]	알림 규칙이 적용하는 대상 리소스 타입 코드 목록 빈 값이면 전체 리소스 타입을 대상으로 함 String 타입 리스트

AlarmTargetAlarmKey

Key	Type	Description
alarmKey	String	알람 키
alarmGroupName	String	알림 수신 그룹명
alarmGroupDesc	String	알림 수신 그룹 설명

AlarmTargetMemberProfile

Key	Type	Description
uuid	String	멤버 UUID
memberType	String	멤버 구분 <종류> 1. TOAST_CLOUD 2. IAM
name	String	멤버 이름
corporationName	String	업체 이름
email	String	멤버 Email
userId	String	멤버 ID

AlarmTargetRole

Key	Type	Description
type	String	역할 타입
roleId	String	역할 ID
roleName	String	역할명
description	String	역할 설명

AlarmTarget

Key	Type	Description
alarmTargetTypeCode	String	알림 대상 타입 코드 <종류> 1. UUID: 조직 멤버 NHN CLOUD, IAM 2. ROLE: 조직 역할, 프로젝트 역할 그룹, 프로젝트 역할 3. ALARM_KEY: 조직 알림 수신 그룹, 프로젝트 알림 수신 그룹 4. WEBHOOK: 웹훅
alarmTarget	String	알림 대상 정보
emailAlarm	String	이메일 수신 여부(Y, N)
smsAlarm	string	SMS 수신 여부(Y, N)
webhookUrl	string	Webhook URL 주소
webhookSecret	string	Webhook 비밀 키

Event

Key	Type	Description
productId	String	상품 ID
eventId	String	이벤트 ID

Target

Key	Type	Description
resourceGroups	ResourceGroup[]	리소스 그룹 목록
resourceTags	ResourceTag[]	리소스 태그 목록

ResourceGroup

Key	Type	Description
resourceGroupId	String	리소스 그룹 ID 목록
resourceGroupName	String	리소스 태그 ID 목록

ResourceTag

Key	Type	Description
tagId	Long	리소스 태그 ID
tagName	String	리소스 태그 이름

예제)

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "alarm": {
    "alarmId": "",
    "alarmName": "",
    "alarmRule": {
      "alarmRuleDescription": "",
      "alarmRuleId": "",
      "alarmRuleName": "",
      "alarmRuleStatusCode": "",
      "resourceTypes": [
        ""
      ]
    },
    "alarmStatusCode": "",
    "appKey": "",
    "cabAlarmKey": "",
    "delDatetime": "yyyy-MM-ddTHH:mm:SS",
    "description": "",
    "modDatetime": "yyyy-MM-ddTHH:mm:SS",
    "operatorUuid": "",
    "regDatetime": "yyyy-MM-ddTHH:mm:SS"
  },
  "alarmTargetAlarmKeys": [
    {
      "alarmGroupDesc": "",
      "alarmGroupName": "",
      "alarmKey": ""
    }
  ],
  "alarmTargetMemberProfiles": [
    {
      "corporationName": "",
      "email": "",
      "memberType": "",
      "name": "",
      "userId": "",
      "uuid": ""
    }
  ],
  "alarmTargetRoles": [
    {
      "description": "",
      "roleId": "",
      "roleName": "",
      "type": ""
    }
  ],
  "alarmTargets": [
    {
      "alarmTarget": "",
      "alarmTargetTypeCode": "",
      "emailAlarm": "",
      "smsAlarm": "",
      "webhookSecret": "",
      "webhookUrl": ""
    }
  ],
  "events": [
    {
      "eventId": "",
      "productId": ""
    }
  ],
  "target": {
    "resourceGroups": [
      {
        "resourceGroupId": "",
        "resourceGroupName": ""
      }
    ],
    "resourceTags": [
      {
        "tagId": 0,
        "tagName": ""
      }
    ]
  }
}

1.2 Event Alarm 조회

[기본 정보]

Method	URI
GET	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms/{alarmId}

권한
O_OWNER, O_ADMIN, O_LOG_VIEWER

등록된 알림에 대해 조회합니다.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	콘솔에서 발급 받은 User Access Key
X-TC-AUTHENTICATION-SECRET	콘솔에서 발급 받은 Secret Access Key

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 Appkey
alarmId	조회할 알림의 ID

[Response Body]

참고 : 1.1) 이벤트 알림 생성의 응답과 동일합니다.

1.3 Event Alarm 리스트 조회

[기본 정보]

Method	URI
POST	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms/search

권한
O_OWNER, O_ADMIN, O_LOG_VIEWER

등록한 이벤트 알림 리스트를 조회합니다. - 요청에 검색 조건을 통해 원하는 알림 목록을 조회할 수 있습니다. - 페이징을 지원합니다.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	콘솔에서 발급 받은 User Access Key
X-TC-AUTHENTICATION-SECRET	콘솔에서 발급 받은 Secret Access Key

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 Appkey

[Query Parameter]

Key	Value	Required
page	조회할 페이지 번호 Default 값: 0	No
size	조회할 알림 개수 Default 값: 10	No
sort	정렬 대상 및 방식 Default 값: modDatetime, DESC	No

[Request Body]

Key	Type	Required	Description
alarmIds	String[]	No	알림 ID 목록 String 타입 리스트
alarmNameAnyLike	String	No	알림 이름(입력값을 포함하는 모든 알림 검색)
alarmRuleIds	String[]	No	알림 규칙 ID 목록 String 타입 리스트
alarmStatusCodes	String[]	No	알림 상태 String 타입 리스트 Default 값: STABLE, DISABLED <종류> 1. STABLE: 활성화 2. DISABLED: 비활성화 3. CLOSED: 삭제
descriptionAnyLike	String	No	알림 설명(입력값을 포함하는 모든 알림 검색)
modDateFrom	Date	No	마지막 수정 일시 시작
modDateTo	Date	No	마지막 수정 일시 종료
operatorUuids	String[]	No	마지막 수정자 UUID 목록 String 타입 리스트
resourceGroupIds	String[]	No	리소스 그룹 목록 String 타입 리스트

{
  "alarmIds": [
    ""
  ],
  "alarmNameAnyLike": "",
  "alarmRuleIds": [
    ""
  ],
  "alarmStatusCodes": [
    ""
  ],
  "descriptionAnyLike": "",
  "modDateFrom": "yyyy-MM-ddTHH:mm:SS",
  "modDateTo": "yyyy-MM-ddTHH:mm:SS",
  "operatorUuids": [
    ""
  ],
  "resourceGroupIds": [
    ""
  ]
}

[Response Body]

Key	Type	Description
alarms	Alarm[]	알람 목록
totalItems	Long	전체 개수

Alarm

Key	Type	Description
alarmId	String	알림 ID
alarmName	String	알림 이름
alarmRule	AlarmRule	알림 규칙 상세 정보
alarmStatusCode	String	알림 상태 코드 <종류> 1. STABLE: 활성화 2. DISABLED: 비활성화 3. CLOSED: 삭제
appKey	String	Appkey 정보
cabAlarmKey	String	알림 수신 그룹 ID
description	String	알림 설명
operatorUuid	String	최종 수정한 사용자 UUID
delDatetime	Date	삭제 일시
modDatetime	Date	수정 일시
regDatetime	Date	등록 일시

AlarmRule

Key	Type	Description
alarmRuleId	String	알림 규칙 ID
alarmRuleStatusCode	String	알림 규칙 상태 코드 <종류> 1. STABLE: 활성화 2. DISABLED: 비활성화 3. CLOSED: 삭제
alarmRuleName	String	알림 규칙 이름
alarmRuleDescription	String	알림 규칙 설명
resourceTypes	String[]	알림 규칙이 적용하는 대상 리소스 타입 코드 목록 빈 값이면 전체 리소스 타입을 대상으로 함 String 타입 리스트

예제)

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "alarms": [
    {
      "alarmId": "",
      "alarmName": "",
      "alarmRule": {
        "alarmRuleDescription": "",
        "alarmRuleId": "",
        "alarmRuleName": "",
        "alarmRuleStatusCode": "",
        "resourceTypes": [
          ""
        ]
      },
      "alarmStatusCode": "",
      "appKey": "",
      "cabAlarmKey": "",
      "delDatetime": "yyyy-MM-ddTHH:mm:SS",
      "description": "",
      "modDatetime": "yyyy-MM-ddTHH:mm:SS",
      "operatorUuid": "",
      "regDatetime": "yyyy-MM-ddTHH:mm:SS"
    }
  ],
  "totalItems": 0
}

1.4. Event Alarm 수정

[기본 정보]

Method	URI
PUT	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms/{alarmId}

권한
O_OWNER, O_ADMIN, O_LOG_VIEWER

등록된 알림을 수정합니다. - 요청한 내용을 모두 변경하므로 변경사항이 없는 내용도 기존 설정 값을 전송해야 합니다.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	콘솔에서 발급 받은 User Access Key
X-TC-AUTHENTICATION-SECRET	콘솔에서 발급 받은 Secret Access Key

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 Appkey
alarmId	수정할 알림의 ID

[Request Body]

참고 : 1.1) 이벤트 알림 생성의 Request Body와 동일합니다.

1.5. Event Alarm 삭제

[기본 정보]

Method	URI
DELETE	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms/{alarmId}

권한
O_OWNER, O_ADMIN, O_LOG_VIEWER

등록된 알림을 삭제합니다.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	콘솔에서 발급 받은 User Access Key
X-TC-AUTHENTICATION-SECRET	콘솔에서 발급 받은 Secret Access Key

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 Appkey
alarmId	삭제할 알림의 ID

[Response Body]

참고 : Common Response Body와 동일합니다.

1.6. Event Alarm 다건 삭제

[기본 정보]

Method	URI
DELETE	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms

권한
O_OWNER, O_ADMIN, O_LOG_VIEWER

등록된 알림을 여러 개 삭제합니다.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	콘솔에서 발급 받은 User Access Key
X-TC-AUTHENTICATION-SECRET	콘솔에서 발급 받은 Secret Access Key

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 Appkey

[Query Parameter]

Key	Value	Required
alarmIds	삭제할 알림 ID의 목록 반드시 1개 이상의 값을 입력해야 합니다.	Yes

[Response Body]

참고 : Common Response Body와 동일합니다.

2. 알림 히스토리

2.1. 알림 히스토리 조회

[기본 정보]

Method	URI
GET	/resource-watcher/v1.0/appkeys/{appKey}/alarms/{alarmId}/alarm-history/{alarmHistoryId}

권한
O_OWNER, O_ADMIN, O_LOG_VIEWER

등록된 알림이 발송한 이력을 단건 조회합니다.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	콘솔에서 발급 받은 User Access Key
X-TC-AUTHENTICATION-SECRET	콘솔에서 발급 받은 Secret Access Key

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 Appkey
alarmId	히스토리를 조회할 알림의 ID
alarmHistoryId	조회할 알림 이력의 ID

[Response Body]

Key	Type	Description
alarm	Alarm	알람
alarmHistory	AlarmHistory	알람 이력
alarmRule	AlarmRule	Scope ID

Alarm

Key	Type	Description
alarmId	String	알림 ID
alarmName	String	알림 이름
description	String	알림 설명

AlarmHistory

Key	Type	Description
alarmHistoryId	String	알람 이력 ID
resource	Resource	리소스 정보
event	Event	이벤트 정보
alarmSendResultTypeCode	String	알림 발송 결과 <종류> 1. SUCCESS: 성공 2. FAILURE: 실패 3. SENDING: 전송 중

AlarmRule

Key	Type	Description
alarmRuleDescription	String	알림 규칙 설명
alarmRuleId	String	알림 규칙 ID
alarmRuleName	String	알림 규칙 이름

Resource

Key	Type	Description
appKey	String	앱키
resourceKey	String	리소스 식별 키
orgId	String	조직 ID
projectId	String	프로젝트 ID
projectName	String	프로젝트 이름
productId	String	상품 ID
resourceAppKey	String	리소스가 속한 상품의 앱키
iaasTenantId	String	IaaS 테넌트 ID
regionCode	String	리전 코드
resourceId	String	리소스 ID
resourceName	String	리소스 이름
resourceTypeCode	String	리소스 타입
resourceCreationTypeCode	String	리소스 생성 타입 <종류> 1. SYSTEM: 시스템 생성 2. USER: 회원 생성
resourceStatusCode	String	리소스 상태 코드 <종류> 1. STABLE: 정상 2. CLOSED: 삭제
description	String	리소스 설명
cloudResourceName	String	리소스의 NHN Cloud Resource Name
createDatetime	Date	이벤트 발생 일시
regDatetime	Date	등록 일시
modDatetime	Date	수정 일시
delDatetime	Date	삭제 일시

Event

Key	Type	Description
appKey	String	이벤트가 발생한 앱키
alarmId	String	알람 ID
eventId	String	이벤트 ID
eventSourceType	String	이벤트를 발생시킨 주체의 타입
eventUser	EventUser	이벤트를 발생시킨 회원
eventTarget	EventTarget	발생한 이벤트의 대상
eventDatetime	String	이벤트 발생 시간
regDatetime	Date	이벤트 등록 일시

EventUser

Key	Type	Description
userIdNo	String	이벤트를 발생시킨 회원의 UUID
userId	String	이벤트를 발생시킨 회원의 이름
userIp	String	이벤트를 발생시킨 회원의 IP
userAgent	String	이벤트를 발생시킨 회원의 에이전트

EventTarget

Key	Type	Description
targetMembers	TargetMember[]	발생한 이벤트의 대상 회원

TargetMember

Key	Type	Description
idNo	String	발생한 이벤트의 대상 회원의 UUID
name	String	발생한 이벤트의 대상 회원의 이름
userCode	String	발생한 이벤트의 대상 회원의 ID(IAM 멤버일 경우)
emailAddress	String	발생한 이벤트의 대상 회원

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "alarm": {
    "alarmId": "",
    "alarmName": "",
    "description": ""
  },
  "alarmHistory": {
    "alarmHistoryId": "",
    "alarmSendResultTypeCode": "",
    "event": {
      "alarmId": "",
      "appKey": "",
      "eventDatetime": "yyyy-MM-ddTHH:mm:SS",
      "eventId": "",
      "eventSourceType": "",
      "eventTarget": {
        "targetMembers": [
          {
            "emailAddress": "",
            "idNo": "",
            "name": "",
            "userCode": ""
          }
        ]
      },
      "eventUser": {
        "userAgent": "",
        "userId": "",
        "userIdNo": "",
        "userIp": ""
      },
      "regDatetime": "yyyy-MM-ddTHH:mm:SS"
    },
    "resource": {
      "appKey": "",
      "cloudResourceName": "",
      "createDatetime": "yyyy-MM-ddTHH:mm:SS",
      "delDatetime": "yyyy-MM-ddTHH:mm:SS",
      "description": "",
      "iaasTenantId": "",
      "modDatetime": "yyyy-MM-ddTHH:mm:SS",
      "orgId": "",
      "productId": "",
      "projectId": "",
      "projectName": "",
      "regDatetime": "yyyy-MM-ddTHH:mm:SS",
      "regionCode": "",
      "resourceAppKey": "",
      "resourceCreationTypeCode": "",
      "resourceId": "",
      "resourceKey": "",
      "resourceName": "",
      "resourceStatusCode": "",
      "resourceTypeCode": ""
    }
  },
  "alarmRule": {
    "alarmRuleDescription": "",
    "alarmRuleId": "",
    "alarmRuleName": ""
  },
  "projectName": ""
}

2.2. 알림 히스토리 리스트 조회

[기본 정보]

Method	URI
GET	/resource-watcher/v1.0/appkeys/{appKey}/alarms/{alarmId}/alarm-history

권한
O_OWNER, O_ADMIN, O_LOG_VIEWER

등록된 알림이 발송한 이력을 모두 조회합니다.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	콘솔에서 발급 받은 User Access Key
X-TC-AUTHENTICATION-SECRET	콘솔에서 발급 받은 Secret Access Key

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 Appkey
alarmId	히스토리를 조회할 알림의 ID

[Query Parameter]

Key	Value	Required
resourceKeys	리소스 식별 키 목록 여러 개 입력 가능	No
resourceNameAnyLike	리소스 식별 키 목록	No
eventIds	이벤트 ID 목록 여러 개 입력 가능	No
eventSourceTypes	이벤트 소스 목록 여러 개 입력 가능	No
projectIds	프로젝트 ID 목록 여러 개 입력 가능	No
productIds	상품 ID 목록 여러 개 입력 가능	No
alarmSendResultTypeCodes	알림 발송 결과 목록(SENDING, SUCCESS, FAILURE) 여러 개 입력 가능	No
regDateFrom	조회할 기간의 시작 일시 yyyy-MM-ddTHH:mm:SS	No
regDateTo	조회할 기간의 종료 일시 yyyy-MM-ddTHH:mm:SS	No
page	조회할 페이지 번호 Default 값: 0	No
size	조회할 알림 개수 Default 값: 10	No
sort	정렬 대상 및 방식	No

[Response Body]

Key	Type	Description
alarmHistories	AlarmHistory[]	알람 이력 목록
totalItems	Long	전체 개수

AlarmHistory

Key	Type	Description
alarmHistoriesId	String	알람 이력 ID
resource	Resource	리소스 정보
event	Event	이벤트 정보
alarmSendResultTypeCode	String	알림 발송 결과 <종류> 1. SUCCESS: 성공 2. FAILURE: 실패 3. SENDING: 전송 중

Resource

Key	Type	Description
appKey	String	앱키
resourceKey	String	리소스 식별 키
orgId	String	조직 ID
projectId	String	프로젝트 ID
projectName	String	프로젝트 이름
productId	String	상품 ID
resourceAppKey	String	리소스가 속한 상품의 앱키
iaasTenantId	String	IaaS 테넌트 ID
regionCode	String	리전 코드
resourceId	String	리소스 ID
resourceName	String	리소스 이름
resourceTypeCode	String	리소스 타입
resourceCreationTypeCode	String	리소스 생성 타입 <종류> 1. SYSTEM: 시스템 생성 2. USER: 회원 생성
resourceStatusCode	String	리소스 상태 코드 <종류> 1. STABLE: 정상 2. CLOSED: 삭제
description	String	리소스 설명
cloudResourceName	String	리소스의 NHN Cloud Resource Name
createDatetime	Date	이벤트 발생 일시
regDatetime	Date	등록 일시
modDatetime	Date	수정 일시
delDatetime	Date	삭제 일시

Event

Key	Type	Description
appKey	String	이벤트가 발생한 앱키
alarmId	String	알람 ID
eventId	String	이벤트 ID
eventSourceType	String	이벤트를 발생시킨 주체의 타입
eventUser	EventUser	이벤트를 발생시킨 회원
eventTarget	EventTarget	발생한 이벤트의 대상
eventDatetime	String	이벤트 발생 시간
regDatetime	Date	이벤트 등록 일시

EventUser

Key	Type	Description
userIdNo	String	이벤트를 발생시킨 회원의 UUID
userId	String	이벤트를 발생시킨 회원의 이름
userIp	String	이벤트를 발생시킨 회원의 IP
userAgent	String	이벤트를 발생시킨 회원의 에이전트

EventTarget

Key	Type	Description
targetMembers	TargetMember[]	발생한 이벤트의 대상 회원

TargetMember

Key	Type	Description
idNo	String	발생한 이벤트의 대상 회원의 UUID
name	String	발생한 이벤트의 대상 회원의 이름
userCode	String	발생한 이벤트의 대상 회원의 ID(IAM 멤버일 경우)
emailAddress	String	발생한 이벤트의 대상 회원

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "alarmHistories": [
    {
      "alarmHistoryId": "",
      "alarmSendResultTypeCode": "",
      "event": {
        "alarmId": "",
        "appKey": "",
        "eventDatetime": "yyyy-MM-ddTHH:mm:SS",
        "eventId": "",
        "eventSourceType": "",
        "eventTarget": {
          "targetMembers": [
            {
              "emailAddress": "",
              "idNo": "",
              "name": "",
              "userCode": ""
            }
          ]
        },
        "eventUser": {
          "userAgent": "",
          "userId": "",
          "userIdNo": "",
          "userIp": ""
        },
        "regDatetime": "yyyy-MM-ddTHH:mm:SS"
      },
      "resource": {
        "appKey": "",
        "cloudResourceName": "",
        "createDatetime": "yyyy-MM-ddTHH:mm:SS",
        "delDatetime": "yyyy-MM-ddTHH:mm:SS",
        "description": "",
        "iaasTenantId": "",
        "modDatetime": "yyyy-MM-ddTHH:mm:SS",
        "orgId": "",
        "productId": "",
        "projectId": "",
        "projectName": "",
        "regDatetime": "yyyy-MM-ddTHH:mm:SS",
        "regionCode": "",
        "resourceAppKey": "",
        "resourceCreationTypeCode": "",
        "resourceId": "",
        "resourceKey": "",
        "resourceName": "",
        "resourceStatusCode": "",
        "resourceTypeCode": ""
      }
    }
  ],
  "totalItems": 0
}

3. Event

3.1. Event 목록 조회

[기본 정보]

Method	URI
GET	/resource-watcher/v1.0/appkeys/{appKey}/events

알림에 설정할 수 있는 이벤트 목록을 조회합니다. - 이벤트는 CloudTrail에 등록된 이벤트 ID를 기반으로 합니다. - 이벤트에 대한 검색 기능을 제공합니다. - 이벤트 이름 또는 상품 이름으로 검색 시 lang을 설정하여 설정된 값에 맞는 언어로 검색할 수 있습니다.

[Request Header]

Key	Value
lang	언어 코드 검색 조건 및 응답 값은 언어 코드에 해당하는 값(ko, en, ja, zh) Default 값: ko

[Path Variable]

Key	Value
appKey	콘솔에서 발급 받은 Appkey

[Query Parameter]

Key	Value	Required
productIdList	검색할 상품 목록 ID 리스트 여러 개 입력 가능	No
productNameLike	검색할 상품 이름	No
eventNameLike	검색할 이벤트 이름	No
page	조회할 페이지 번호 Default 값: 0	No
size	조회할 알림 개수 Default 값: 10	No
sort	정렬 대상 및 방식 Default 값: productName:ASC,eventName:ASC	No

[Response Body]

Key	Type	Description
events	Event[]	이벤트 목록
totalItems	Long	전체 개수

Event

Key	Type	Description
eventId	String	이벤트 ID
productId	String	상품 ID
productName	String	상품명

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "eventPage": "",
  "events": [
    {
      "eventId": "",
      "productId": "",
      "productName": ""
    }
  ],
  "totalItems": 0
}

Governance & Audit > Resource Watcher > API 가이드
User Access Key & Secret Access Key
Public API URL & Appkey 확인
REST API 가이드
Common Response Body
1. Alarm
2. 알림 히스토리
3. Event

TOP

Governance & Audit > Resource Watcher > API 가이드

User Access Key & Secret Access Key

Public API URL & Appkey 확인

REST API 가이드

Common Response Body

1. Alarm

1.1 Alarm 등록하기

1.2 Event Alarm 조회

1.3 Event Alarm 리스트 조회

1.4. Event Alarm 수정

1.5. Event Alarm 삭제

1.6. Event Alarm 다건 삭제

2. 알림 히스토리

2.1. 알림 히스토리 조회

2.2. 알림 히스토리 리스트 조회

3. Event

3.1. Event 목록 조회

Table of Contents